home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / faxem20.zip / FAXEM.DOC < prev    next >
Text File  |  1993-03-01  |  12KB  |  285 lines
  1.  ═══════════════════════════════════════════════════════════════════════════
  2.  
  3.                Faxem Release 2.0
  4.  
  5.             Fax ASCII Text file while Online!
  6.  
  7.             Door Registration is only $25.00!
  8.  
  9.           Written by: Jerry Liddle
  10.               119 Edward Drive
  11.               Swedesboro, New Jersey 08085
  12.  
  13.       The Beckett BBS (609) 467-3898 USR 14.4 Dual Standard
  14.               (609) 467-8612 USR 16.8 Dual Standard
  15.               (609) 467-0515 14.4 Boca V.32bis
  16.  ═══════════════════════════════════════════════════════════════════════════
  17.  
  18.                    Warranty
  19.  
  20.  This product is provided "as is" without warranty of any kind. The entire
  21.  risk as to the results and  performance of the program is assumed by you.
  22.  Futhermore, the  author does  not warrant, guarantee, or  make any  other
  23.  representations regarding  the use of,  or the  results of the use of the
  24.  program,  and you  rely on the  program and  results  solely at  your own
  25.  risk.  The author  cannot and  will not accept  responsibility for system
  26.  damage, loss of profit, or any other special, consequential or incidental 
  27.  damages  resulting  from  the  use  or  inability  to  use this  product.
  28.  
  29.     FAXEM will run on systems that are compatible with PCBOARD.SYS, 
  30.     USERS.SYS, DOOR.SYS, CALLINFO.BBS, USERINFO.DAT, SFDOORS.DAT, 
  31.     GTUSER.DAT, TRIBBS.SYS, CHAIN.TXT or DORINFOx.DEF for interfacing 
  32.     to the BBS.
  33.  
  34.  
  35. Overview of Faxem
  36. ──────────────────────────────────────────────────────────────────────────
  37. Ok, Folks.  This is my first attempt at writting a door.  So be patient
  38. with me.  Needless to say, I'm not good at writing docs either.  If you 
  39. need help setting-up Faxem, TOUGH...   Just kidding...  I can be reached
  40. through my BBS.  I also monitor many RIME conferences.  Especially the
  41. Doors and GAP Conferences.
  42.  
  43. Faxem was written to provide users of my BBS the ability to Fax ASCII
  44. Text files to other fax machines in the area.
  45.  
  46. I have the door set up to allow FREE local faxing.  It's a great service
  47. that is fairly cheap to add to your system.  You can make your own arrange-
  48. ments with users to have them pay per fax for toll calls.  The door keeps
  49. track of the number of pages sent.  I charge per page for Long Distance.        
  50.  
  51. All in all, I think you'll be quite pleased.
  52.  
  53. ************************ N E W   F E A T U R E S **************************
  54. For those who have fax modems that cannot run BitFax Software, I have added
  55. a feature that will allow your users to upload their fax document into the
  56. door and save the file.  The user can leave a comment to the sysop informing
  57. him/her that there is a fax request pending.  Also, if the sysop logs into
  58. door local or remote, he/she will be told that a fax request is pending.
  59. The sysop sends the file during a maintenance event, or uses the fax
  60. software to schedule fax send.  Use your imagination.
  61.  
  62. Fossil Driver Support
  63. ---------------------
  64. Faxem supports the use of Fossil drivers.  To tell your Door to use the
  65. Fossil driver instead of the standard COM ports, just put /FD on the command
  66. line when running the door. For example:
  67.  
  68.      
  69.      FAXEM FAXEM.CFG /FD
  70.  
  71. indicates that a Fossil driver is present and should be used. If no Fossil
  72. driver is detected, FAXEM will print a message to that effect and exit
  73. the door gracefully.
  74.  
  75. Environment Variables
  76. ---------------------
  77. FAXEM supports COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  78. COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  79. number after the configuration filename.  EXAMPLE:
  80.  
  81.     FAXEM FAXEM.CFG /5  or
  82.     FAXEM FAXEM.CFG /%IRQ%  for the environment variable.
  83.  
  84. The /5 tells FAXEM to use IRQ5 rather than the standard IRQ4 that
  85. is normally used with COM1. No /x parameter is needed for the standard IRQ's.
  86.  
  87. When specifying the location of the system file on line 1 of the doors .CFG
  88. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  89. and %wcnodeid%. Some examples:
  90.  PCBoard: 
  91.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  92.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  93.  
  94.  Wildcat!:
  95.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  96.  
  97. Non-PCBoard systems may use the PCB environment variables by setting them
  98. in either AUTOEXEC.BAT or in the batch file that runs the door. For example:
  99.  
  100.  SET PCBDRIVE=C:
  101.  SET PCBDIR=\BBSDIR
  102.  SET PCBNODE=1
  103.  
  104. **************************************************************************
  105.  
  106. Fax-Door Requirements
  107. ──────────────────────────────────────────────────────────────────────────
  108. - You'll need room in your computer for an internal Fax-Modem.  That not only
  109.   means phsyical space, but also free interupts and com ports.  An external
  110.   modem may also be used.  (I use an external modem)
  111.  
  112. - You need an extra phone line, in ADDITION to the BBS Line, as the door
  113.   faxes with the caller online.  I cheated a little here, I use my voice
  114.   line.  Odds are that the line will be free most of the time.
  115.  
  116. - You need a Fax modem that uses the BitFax software (C) 1989 BIT Software,
  117.   Inc.  All Rights Reserved.  I have used BitFax v3.0 successfully.
  118.  
  119.   Else, try the new feature added mentioned above.
  120.   See sample config file for setting up this feature...
  121.  
  122. - All files for the door should be placed in the BitFax directory.
  123.   By this I mean, run the door from the BitFax Directory...
  124.  
  125.   The door files may reside anywhere if you are not using BitFax.
  126.  
  127. - This only works on the node where the Fax-Modem is inserted.  On a multi
  128.   node system, this means the fax service will only be available on one of
  129.   your nodes, unless you have more than one Fax-Modem.
  130.   True multinode if using the OTHER feature (new feature) mentioned above.
  131.  
  132.   Naturally, if you are not using BitFax, the door is truely multinode.
  133.  
  134.  
  135. - You must have a copy of DSZ in your Path or in the Door Directory
  136.  
  137. - The door shells out to run BitFax and DSZ to accept the uploaded file to fax.
  138.   Boards operating under DoubleDos or Desqview must be sure they have enough
  139.   RAM leftover for proper door operation.
  140.  
  141. - You will NOT need a copy of BRUN45.EXE for the door to operate.
  142.  
  143. - This door was written for system that use ANSI.SYS in their config.sys files.
  144.   
  145. Files needed for Fax-Door Operation
  146. ──────────────────────────────────────────────────────────────────────────
  147. If you have any doubt about the integrity of the files contained in this
  148. Archive, feel free to call my BBS in Swedesboro, New Jersey and download
  149. the latest version.  The Beckett BBS, (609)467-3898/8612/0515
  150.  
  151. Files included with Faxem and created by the door:  Files marked with an
  152. asterisk "*" are created by the door.  Be sure to check the transfer batch
  153. files so they are set for the correct com port that the door will be using.
  154.  
  155. NOTE:  Do not change the names of the file transfer Protocol Batch Files
  156.        They may be edited to add options
  157.  
  158.     FAXEM.DOC     <----- The How To File - The Documentation
  159.  
  160.     FAXEM.EXE     <----- This is the door executable file
  161.  
  162.     FAXEM.CFG     <----- The door configuration file (Instructions in Sample)
  163.  
  164.     FAXEMWLC.ASC  <----- The door ascii welcome screen (Do Not Alter)
  165.  
  166.     FAXEMWLC.ANS  <----- The door Ansi welcome screen (Do Not Alter)
  167.  
  168.     FAXLOCAL.TXT  <----- ASCII file containing local calling prefixes (Edit)
  169.              One prefix per line (For area code where BBS lives)
  170.  
  171.     FAXZONE1.TXT  <----- ASCII file containing local calling prefixes (edit)
  172.              for additional local area code on line 6 of faxem.cfg
  173.              One prefix per line     (create file if needed)
  174.  
  175.     FAXZONE2.TXT  <----- ASCII file containing local calling prefixes (edit)
  176.              for additional local area code on line 7 of faxem.cfg
  177.              One prefix per line     (create file if needed)
  178.  
  179.     FAXZONE3.TXT  <----- ASCII file containing local calling prefixes (edit)
  180.              for additional local area code on line 8 of faxem.cfg
  181.              One prefix per line     (create file if needed)
  182.  
  183.    *FAXUSER.DAT   <----- Door user data file (Do Not Alter)
  184.  
  185.    *FAX2SEND.DAT  <----- Door user data file of pending faxes.  Can be
  186.              deleted when all faxes listed have been sent.
  187.              The door will also ask if you wish to delete this
  188.              file after it is displayed to the sysop after he/she
  189.              enters the door.
  190.  
  191.     INSTRUCT.TXT  <----- Instructions displayed by door (May be Edited)
  192.              This file may be edited to inform users how
  193.              you have the door set to operatate with BitFax
  194.  
  195.     DIRECT.TXT    <----- Same purpose as INSTRUCT.TXT.  Directions for users
  196.              when the door is operated with OTHER than BitFax
  197.              Software.
  198.  
  199.     REGISTER.FRM  <----- Registration Form
  200.  
  201.  
  202.     XM1KG.BAT     <----- File transfer batch files (Do Not Rename - May Edit)
  203.     XMDIK.BAT     <-----                "
  204.     XMDCRC.BAT    <-----                "
  205.     YMD.BAT       <-----                "
  206.     YMD1KG.BAT    <-----                "
  207.     ZMD.BAT       <-----                "
  208.  
  209. If using BitFax software, all of the above files should be in the same
  210. subdirectory as your BitFax software.
  211.  
  212. To call the door from with a BBS program:
  213.  
  214.     Faxem Faxem.cfg [/x]
  215.  
  216.     For Multi-Node operation, each node's configuration file must have
  217.     a unique name. ie. Faxem1.cfg for Node 1, Faxem2.cfg for Node 2, etc.
  218.  
  219.        [x] = optional parameter for non-standard com port.
  220.          The door supports com ports 1-4, but by using the
  221.          /x parameter you can assign other than the standard
  222.          irq for com port 1-4
  223.  
  224.          Example:  To use Com1 with Irq3
  225.                Faxem Faxem.cfg /3
  226. ==============================================================================
  227. EDITING THE USER RECORD
  228. ==============================================================================
  229.   The door automatically knows when the sysop is in the door.  Entering the
  230.   Asterisk (*) key will bring up the user editor.  This will allow you to
  231.   enable long distance faxing for users of your choice.  You make the 
  232.   arrangement as to who, how, and when the toll call is to be paid.  I have
  233.   my users prepay for this service.  I charge per page to fax.  The editor
  234.   is basically self explanatory.
  235.  
  236. Editor Menu:        1. Edit A User Account
  237.             2. Delete A User Account
  238.             Q. Return To Fax-Em
  239.             G. Log-Off System
  240.  
  241.   Edit A User:  A. User Number     <----- User's record Number
  242.         B. Pages           <----- User's preapproved L/D Pages
  243.         C. Sent            <----- Pages a user has sent
  244.            Protocol        <----- User's default protocol 
  245.         D. Long Distance   <----- Y or N (enables/disables L/D
  246.             
  247. SETTING UP BITFAX
  248. ──────────────────────────────────────────────────────────────────────────
  249. Suggest following the instructions for BitFax when installing the software.
  250. Make a subdirectory called BITFAX on your drive.
  251. Change to the subdirectory, and copy the contents of the BitFax/SR Program
  252. disk into the subdirectory.  Next, place the Faxem files in this directory,
  253. as Faxem will read the Log file created by BitFax.
  254.  
  255. Be sure to set your com port correctly on the Fax-Modem.  I run a USR HST
  256. 14.4 on Com2 and have my Fax-Modem set to use Com1.
  257.  
  258. Once your Fax-Modem is installed and your software is loaded onto the hard
  259. drive you should type BITFAX and set up the BitFax parameters.  Please
  260. follow the BitFax manual.  Their manual contains step by step instructions.
  261.  
  262.  
  263. Registration Cost
  264. ──────────────────────────────────────────────────────────────────────────
  265. The DOOR only costs $25.00!!  It is a full working version, except
  266. that it will only allow 10 users in the data base and say it is an
  267. EVALUATION COPY on the welcome screen.
  268.  
  269.  
  270.  
  271. Support the Shareware concept...
  272. ──────────────────────────────────────────────────────────────────────────
  273. This door may be used for an Evaluation period of 30 days.  After that, I
  274. would prefer that you register the program for continued use.
  275.  
  276. To Register, please print out and return the REGISTER.FRM in the Zip file.
  277. When you register, you may call my BBS and obtain your registration number,
  278. which will unlock all the features of the door.  When registered, the door
  279. will display your BBS Name on the Welcome Screen.  You can also register
  280. online with a credit card (Type ORDER at the Main Menu).
  281.  
  282.  
  283. Thanks for your support!
  284.  
  285.